Skip to main content
Feedback

Usage

This section includes examples of how to use the SOAP Connector. All examples have an endpoint key of 794k2psw642cf.

Examples

Request HeadersRequest PayloadPre-Input ConfigResponse HeadersCache TTLResponse PayloadComments
Content-Type: application/xml<?xml version="1.0" encoding="UTF-8"?><employee><first-name>Jane</first-name><last-name>Doe</last-name><address>Paris</address><phone-number>123456</phone-number></employee> Content-Type: application/jsonEndpoint Level TTL : 30{"iata_number": "12345678"}

Caching: Yes

If the second request comes within 30 seconds of the same endpoint with the same request payload, the response is retrieved from the cache.

Content-Type: application/xml<?xml version="1.0" encoding="UTF-8"?> <employee> <first-name>Jane</first-name> <last-name>Doe</last-name> <address>Paris</address> <phone-number>123456</phone-number> </employee> Content-Type: application/zip Zip file attached in the response.

Caching: No

Caching will not be performed for binary responses.

Content-Type: application/json{"iata_number": "12345678"}-Content-Type : application/xml

Service Level TTL : 30

Endpoint Level TTL : 60

<?xml version=\"1.0\" encoding=\"UTF-8\"?><soapenv:Envelope xmlns:soapenv=\" [http://schemas.xmlsoap.org/soap/envelope/\](HTTP://SCHEMAS.XMLSOAP.ORG/SOAP/ENVELOPE//) " xmlns:urn=\"urn:com.cgi.payment.nspartyservice.v1\" xmlns:urn1=\"urn:com.cgi.common.service.types.v1\" xmlns:urn2=\"urn:com.cgi.common.types.v1\"><soapenv:Header /><soapenv:Body><urn:VersionId>1</urn:VersionId><urn:RegistedEntityPk>OrgKey3</urn:RegistedEntityPk></soapenv:Body></soapenv:Envelope>

Caching: Yes

If the second request comes within 30 seconds of the same endpoint with the same request payload, the response is retrieved from the cache.

Content-Type: application/xml<?xml version="1.0" encoding="UTF-8"?><availabilityRQ xmlns="http://www.acme.com/schemas/messages/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" dailyRate="true"><stay checkIn="2016-06-15" checkOut="2016-06-16" /></availabilityRQ>-Content-Type : application/xml <?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:com.cgi.payment.nspartyservice.v1" xmlns:urn1="urn:com.cgi.common.service.types.v1" xmlns:urn2="urn:com.cgi.common.types.v1"><soapenv:Header /><soapenv:Body><urn:VersionId>1</urn:VersionId><urn:RegistedEntityPk>OrgKey3</urn:RegistedEntityPk></soapenv:Body></soapenv:Envelope>

Caching: No

Caching is only performed for the SOAP request.

Content-Type: application/soap+xml<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:com.cgi.payment.nspartyservice.v1" xmlns:urn1="urn:com.cgi.common.service.types.v1" xmlns:urn2="urn:com.cgi.common.types.v1"><soapenv:Header/><soapenv:Body><urn:VersionId>1</urn:VersionId><urn:RegistedEntityPk>OrgKey3</urn:RegistedEntityPk></soapenv:Body></soapenv:Envelope>headers:   {"Content-Type"}Content-Type: application/json {"iata_number": "12345678"}

Caching: Yes

If Cache TTL is not configured on service and endpoint level and second request comes within 300 seconds on same endpoint with same request payload and same Content-Type, then response will be fetched from cache.

Content-Type: text/xml<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:com.cgi.payment.nspartyservice.v1" xmlns:urn1="urn:com.cgi.common.service.types.v1" xmlns:urn2="urn:com.cgi.common.types.v1"><soapenv:Header /><soapenv:Body><urn:VersionId>1</urn:VersionId><urn:RegistedEntityPk>OrgKey3</urn:RegistedEntityPk></soapenv:Body></soapenv:Envelope>headers:{"Content-Type", "Host"}, cache_ttl:30Content-Type: application/json {"iata_number": "12345678"}

Caching: Yes

If Cache TTL is not configured on service and endpoint level and second request comes within 300 seconds on same endpoint with same request payload and same Content-Type, then response will be fetched from cache.

Content-Type: text/xml<?xml version="1.0" encoding="UTF-8"?><availabilityRQ xmlns="http://www.acme.com/schemas/messages/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" dailyRate="true"><stay checkIn="2016-06-15" checkOut="2016-06-16" />-Content-Type: application/json {"iata_number": "12345678"}

Caching: No

A 400 Bad Request error is displayed because the request payload contains SOAP message.

-<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:com.cgi.payment.nspartyservice.v1" xmlns:urn1="urn:com.cgi.common.service.types.v1" xmlns:urn2="urn:com.cgi.common.types.v1"><soapenv:Header /><soapenv:Body><urn:VersionId>1</urn:VersionId><urn:RegistedEntityPk>OrgKey3</urn:RegistedEntityPk></soapenv:Body></soapenv:Envelope>-Content-Type: application/json {"iata_number": "12345678"}

Caching: No

Caching is not performed as the request's Content-Type is not defined.

Content-Type: application/xml<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:com.cgi.payment.nspartyservice.v1" xmlns:urn1="urn:com.cgi.common.service.types.v1" xmlns:urn2="urn:com.cgi.common.types.v1"><soapenv:Header /><soapenv:Body><urn:VersionId>1</urn:VersionId><urn:RegistedEntityPk>OrgKey3</urn:RegistedEntityPk></soapenv:Body></soapenv:Envelope>-- {"iata_number": "12345678"}

Caching: No

Caching is not performed as the request's Content-Type is not defined.

Content-Type: application/xml--Content-Type: application/json {"iata_number": "12345678"}

Caching: No

Caching is not performed as the request's payload is empty.

On this Page